home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / include / pango-1.0 / pango / pango-layout.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-04-25  |  11.9 KB  |  272 lines

  1. /* Pango
  2.  * pango-layout.h: Highlevel layout driver
  3.  *
  4.  * Copyright (C) 2000 Red Hat Software
  5.  *
  6.  * This library is free software; you can redistribute it and/or
  7.  * modify it under the terms of the GNU Library General Public
  8.  * License as published by the Free Software Foundation; either
  9.  * version 2 of the License, or (at your option) any later version.
  10.  *
  11.  * This library is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the GNU
  14.  * Library General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU Library General Public
  17.  * License along with this library; if not, write to the
  18.  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19.  * Boston, MA 02111-1307, USA.
  20.  */
  21.  
  22. #ifndef __PANGO_LAYOUT_H__
  23. #define __PANGO_LAYOUT_H__
  24.  
  25. #include <pango/pango-attributes.h>
  26. #include <pango/pango-context.h>
  27. #include <pango/pango-glyph-item.h>
  28. #include <pango/pango-tabs.h>
  29.  
  30. G_BEGIN_DECLS
  31.  
  32. typedef struct _PangoLayout      PangoLayout;
  33. typedef struct _PangoLayoutClass PangoLayoutClass;
  34. typedef struct _PangoLayoutLine  PangoLayoutLine;
  35.  
  36. /* For backwards compatiblity */
  37. typedef PangoGlyphItem PangoLayoutRun;
  38.  
  39. typedef enum {
  40.   PANGO_ALIGN_LEFT,
  41.   PANGO_ALIGN_CENTER,
  42.   PANGO_ALIGN_RIGHT
  43. } PangoAlignment;
  44.  
  45. typedef enum {
  46.   PANGO_WRAP_WORD,
  47.   PANGO_WRAP_CHAR,
  48.   PANGO_WRAP_WORD_CHAR
  49. } PangoWrapMode;
  50.  
  51. /**
  52.  * PangoEllipsizeMode
  53.  * @PANGO_ELLIPSIZE_NONE: No ellipsization
  54.  * @PANGO_ELLIPSIZE_START: Omit characters at the start of the text
  55.  * @PANGO_ELLIPSIZE_MIDDLE: Omit characters in the middle of the text
  56.  * @PANGO_ELLIPSIZE_END: Omit characters at the end of the text
  57.  * 
  58.  * The #PangoEllipsizeMode type describes what sort of (if any)
  59.  * ellipsization should be applied to a line of text. In
  60.  * the ellipsization process characters are removed from the
  61.  * text in order to make it fit to a given width and replaced
  62.  * with an ellipsis.
  63.  */
  64. typedef enum {
  65.   PANGO_ELLIPSIZE_NONE,
  66.   PANGO_ELLIPSIZE_START,
  67.   PANGO_ELLIPSIZE_MIDDLE,
  68.   PANGO_ELLIPSIZE_END
  69. } PangoEllipsizeMode;
  70.  
  71. struct _PangoLayoutLine
  72. {
  73.   PangoLayout *layout;
  74.   gint         start_index;     /* start of line as byte index into layout->text */
  75.   gint         length;        /* length of line in bytes */
  76.   GSList      *runs;
  77.   guint        is_paragraph_start : 1;  /* TRUE if this is the first line of the paragraph */ 
  78.   guint        resolved_dir : 3;  /* Resolved direction of line */
  79. };
  80.  
  81. #define PANGO_TYPE_LAYOUT              (pango_layout_get_type ())
  82. #define PANGO_LAYOUT(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), PANGO_TYPE_LAYOUT, PangoLayout))
  83. #define PANGO_LAYOUT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), PANGO_TYPE_LAYOUT, PangoLayoutClass))
  84. #define PANGO_IS_LAYOUT(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), PANGO_TYPE_LAYOUT))
  85. #define PANGO_IS_LAYOUT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), PANGO_TYPE_LAYOUT))
  86. #define PANGO_LAYOUT_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), PANGO_TYPE_LAYOUT, PangoLayoutClass))
  87.  
  88. /* The PangoLayout and PangoLayoutClass structs are private; if you
  89.  * need to create a subclass of these, mail otaylor@redhat.com
  90.  */
  91.  
  92. GType        pango_layout_get_type       (void) G_GNUC_CONST;
  93. PangoLayout *pango_layout_new            (PangoContext   *context);
  94. PangoLayout *pango_layout_copy           (PangoLayout    *src);
  95.  
  96. PangoContext  *pango_layout_get_context    (PangoLayout    *layout);
  97.  
  98. void           pango_layout_set_attributes (PangoLayout    *layout,
  99.                         PangoAttrList  *attrs);
  100. PangoAttrList *pango_layout_get_attributes (PangoLayout    *layout);
  101.  
  102. void           pango_layout_set_text       (PangoLayout    *layout,
  103.                         const char     *text,
  104.                         int             length);
  105. const char    *pango_layout_get_text       (PangoLayout    *layout);
  106.  
  107. void           pango_layout_set_markup     (PangoLayout    *layout,
  108.                                             const char     *markup,
  109.                                             int             length);
  110.  
  111. void           pango_layout_set_markup_with_accel (PangoLayout    *layout,
  112.                                                    const char     *markup,
  113.                                                    int             length,
  114.                                                    gunichar        accel_marker,
  115.                                                    gunichar       *accel_char);
  116.  
  117. void           pango_layout_set_font_description (PangoLayout                *layout,
  118.                           const PangoFontDescription *desc);
  119.  
  120. G_CONST_RETURN PangoFontDescription *pango_layout_get_font_description (PangoLayout *layout);
  121.  
  122. void           pango_layout_set_width            (PangoLayout                *layout,
  123.                           int                         width);
  124. int            pango_layout_get_width            (PangoLayout                *layout);
  125. void           pango_layout_set_wrap             (PangoLayout                *layout,
  126.                                                   PangoWrapMode               wrap);
  127. PangoWrapMode  pango_layout_get_wrap             (PangoLayout                *layout);
  128. void           pango_layout_set_indent           (PangoLayout                *layout,
  129.                           int                         indent);
  130. int            pango_layout_get_indent           (PangoLayout                *layout);
  131. void           pango_layout_set_spacing          (PangoLayout                *layout,
  132.                           int                         spacing);
  133. int            pango_layout_get_spacing          (PangoLayout                *layout);
  134. void           pango_layout_set_justify          (PangoLayout                *layout,
  135.                           gboolean                    justify);
  136. gboolean       pango_layout_get_justify          (PangoLayout                *layout);
  137. void           pango_layout_set_auto_dir          (PangoLayout                *layout,
  138.                           gboolean                    auto_dir);
  139. gboolean       pango_layout_get_auto_dir          (PangoLayout                *layout);
  140. void           pango_layout_set_alignment        (PangoLayout                *layout,
  141.                           PangoAlignment              alignment);
  142. PangoAlignment pango_layout_get_alignment        (PangoLayout                *layout);
  143.  
  144. void           pango_layout_set_tabs             (PangoLayout                *layout,
  145.                                                   PangoTabArray              *tabs);
  146.  
  147. PangoTabArray* pango_layout_get_tabs             (PangoLayout                *layout);
  148.  
  149. void           pango_layout_set_single_paragraph_mode (PangoLayout                *layout,
  150.                                                        gboolean                    setting);
  151. gboolean       pango_layout_get_single_paragraph_mode (PangoLayout                *layout);
  152.  
  153. void               pango_layout_set_ellipsize (PangoLayout        *layout,
  154.                            PangoEllipsizeMode  ellipsize);
  155. PangoEllipsizeMode pango_layout_get_ellipsize (PangoLayout        *layout);
  156.  
  157. void           pango_layout_context_changed (PangoLayout    *layout);
  158.  
  159. void     pango_layout_get_log_attrs (PangoLayout    *layout,
  160.                      PangoLogAttr  **attrs,
  161.                      gint           *n_attrs);
  162.  
  163. void     pango_layout_index_to_pos         (PangoLayout    *layout,
  164.                         int             index_,
  165.                         PangoRectangle *pos);
  166. void     pango_layout_get_cursor_pos       (PangoLayout    *layout,
  167.                         int             index_,
  168.                         PangoRectangle *strong_pos,
  169.                         PangoRectangle *weak_pos);
  170. void     pango_layout_move_cursor_visually (PangoLayout    *layout,
  171.                         gboolean        strong,
  172.                         int             old_index,
  173.                         int             old_trailing,
  174.                         int             direction,
  175.                         int            *new_index,
  176.                         int            *new_trailing);
  177. gboolean pango_layout_xy_to_index          (PangoLayout    *layout,
  178.                         int             x,
  179.                         int             y,
  180.                         int            *index_,
  181.                         int            *trailing);
  182. void     pango_layout_get_extents          (PangoLayout    *layout,
  183.                         PangoRectangle *ink_rect,
  184.                         PangoRectangle *logical_rect);
  185. void     pango_layout_get_pixel_extents    (PangoLayout    *layout,
  186.                         PangoRectangle *ink_rect,
  187.                         PangoRectangle *logical_rect);
  188. void     pango_layout_get_size             (PangoLayout    *layout,
  189.                         int            *width,
  190.                         int            *height);
  191. void     pango_layout_get_pixel_size       (PangoLayout    *layout,
  192.                         int            *width,
  193.                         int            *height);
  194.  
  195. int              pango_layout_get_line_count       (PangoLayout    *layout);
  196. PangoLayoutLine *pango_layout_get_line             (PangoLayout    *layout,
  197.                             int             line);
  198. GSList *         pango_layout_get_lines            (PangoLayout    *layout);
  199.  
  200. #define PANGO_TYPE_LAYOUT_LINE (pango_layout_line_get_type ())
  201.  
  202. GType    pango_layout_line_get_type     (void) G_GNUC_CONST;
  203.  
  204. PangoLayoutLine *pango_layout_line_ref   (PangoLayoutLine *line);
  205. void             pango_layout_line_unref (PangoLayoutLine *line);
  206.  
  207. gboolean pango_layout_line_x_to_index   (PangoLayoutLine  *line,
  208.                      int               x_pos,
  209.                      int              *index_,
  210.                      int              *trailing);
  211. void     pango_layout_line_index_to_x   (PangoLayoutLine  *line,
  212.                      int               index_,
  213.                      gboolean          trailing,
  214.                      int              *x_pos);
  215. void     pango_layout_line_get_x_ranges (PangoLayoutLine  *line,
  216.                      int               start_index,
  217.                      int               end_index,
  218.                      int             **ranges,
  219.                      int              *n_ranges);
  220. void     pango_layout_line_get_extents  (PangoLayoutLine  *line,
  221.                      PangoRectangle   *ink_rect,
  222.                      PangoRectangle   *logical_rect);
  223. void     pango_layout_line_get_pixel_extents (PangoLayoutLine *layout_line,
  224.                           PangoRectangle  *ink_rect,
  225.                           PangoRectangle  *logical_rect);
  226.  
  227. typedef struct _PangoLayoutIter PangoLayoutIter;
  228.  
  229. #define PANGO_TYPE_LAYOUT_ITER         (pango_layout_iter_get_type ())
  230.  
  231. GType            pango_layout_iter_get_type (void);
  232.  
  233. PangoLayoutIter *pango_layout_get_iter  (PangoLayout     *layout);
  234. void             pango_layout_iter_free (PangoLayoutIter *iter);
  235.  
  236. int              pango_layout_iter_get_index (PangoLayoutIter *iter);
  237. PangoLayoutRun  *pango_layout_iter_get_run   (PangoLayoutIter *iter);
  238. PangoLayoutLine *pango_layout_iter_get_line  (PangoLayoutIter *iter);
  239. gboolean         pango_layout_iter_at_last_line (PangoLayoutIter *iter);
  240.  
  241. gboolean pango_layout_iter_next_char    (PangoLayoutIter *iter);
  242. gboolean pango_layout_iter_next_cluster (PangoLayoutIter *iter);
  243. gboolean pango_layout_iter_next_run     (PangoLayoutIter *iter);
  244. gboolean pango_layout_iter_next_line    (PangoLayoutIter *iter);
  245.  
  246. void pango_layout_iter_get_char_extents    (PangoLayoutIter *iter,
  247.                                             PangoRectangle  *logical_rect);
  248. void pango_layout_iter_get_cluster_extents (PangoLayoutIter *iter,
  249.                                             PangoRectangle  *ink_rect,
  250.                                             PangoRectangle  *logical_rect);
  251. void pango_layout_iter_get_run_extents     (PangoLayoutIter *iter,
  252.                                             PangoRectangle  *ink_rect,
  253.                                             PangoRectangle  *logical_rect);
  254. void pango_layout_iter_get_line_extents    (PangoLayoutIter *iter,
  255.                                             PangoRectangle  *ink_rect,
  256.                                             PangoRectangle  *logical_rect);
  257. /* All the yranges meet, unlike the logical_rect's (i.e. the yranges
  258.  * assign between-line spacing to the nearest line)
  259.  */
  260. void pango_layout_iter_get_line_yrange     (PangoLayoutIter *iter,
  261.                                             int             *y0_,
  262.                                             int             *y1_);
  263. void pango_layout_iter_get_layout_extents  (PangoLayoutIter *iter,
  264.                                             PangoRectangle  *ink_rect,
  265.                                             PangoRectangle  *logical_rect);
  266. int  pango_layout_iter_get_baseline        (PangoLayoutIter *iter);
  267.  
  268. G_END_DECLS
  269.  
  270. #endif /* __PANGO_LAYOUT_H__ */
  271.  
  272.